Get Comments
AutomatR.DocuSign.Activities.GetComments
The "Get Comments" activity in AutomatR is part of the DocuSign Envelope activities package, allowing users to retrieve comments transcript from a specified envelope. This activity is useful for obtaining information about comments associated with the documents within the envelope for further analysis and processing in automated workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Overwrite | If checked, it enables you to download a file with the same name as the one in the destination location. Boolean variables to determine whether to overwrite an existing file. |
| Envelope ID | Enter the ID of the envelope. This field supports only Strings or String variables. |
| Folder Path | Enter the file path for storing the comments transcript from the envelope. This field supports only Strings or String variables. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Comments" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
How to use:
- Drag and drop the "Get Comments" activity onto the workflow.
- Configure the properties by specifying the envelope ID, folder path for storing comments, and optionally, set the delay and overwrite parameters.
- Execute the workflow to retrieve the comments transcript from the specified envelope.
Important Note:
- Ensure that the "Get Comments" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Get Comments" activity is used to retrieve comments transcript for an envelope:
Get Comments:
Delay: 5
Envelope ID: "abc123"
Folder Path: "C:\CommentsFolder"
Overwrite: true
In this example, the activity retrieves the comments transcript for the envelope with ID "abc123" and stores it in a PDF file at the specified folder path "C:\CommentsFolder". The "Overwrite" option is set to true, allowing the activity to overwrite an existing file if present.